home *** CD-ROM | disk | FTP | other *** search
/ Publisher Platinum / Publisher Platinum.iso / clipart / utils / misc / readme.com (.txt) < prev    next >
Encoding:
Graham's TXT2COM  |  1993-04-30  |  20.1 KB  |  410 lines
  1.  
  2.  
  3.                     TXT2COM Version 2.0 Documentation
  4.                     Copyright 1987 by Keith P. Graham
  5.  
  6.                               Main Menu
  7.  
  8.  
  9.                      F1 - Revision History
  10.                      F2 - Program Description
  11.                      F3 - Limits
  12.                      F4 - Writing Out the Original File
  13.                      F5 - Adding Color
  14.                      F6 - Using Function Keys
  15.                      F7 - Sample Colors
  16.                      F8 - TXT2RES Special Instructions
  17.                      F9 - Altering the Hot Key with HOTFIX.COM
  18.                      F10 - Usage and License
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26. ~#1
  27.         Version 2.0 - Added Function Key support. Produced a
  28.         memory resident version.
  29.         Version 1.1 - Minor bug fixes. Fixed problem with files
  30.         shorter than 1 page and repaint of pages already displayed.
  31.         Version 1.0 - First release
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58. ~#2                     Program Description
  59.  
  60.             TXT2COM is a simple program which makes an ascii text file into a
  61.        full screen display. It is useful for documentation and for "README"
  62.        files which can be shown on the screen and then printed out. The COM
  63.        file created by TXT2COM is easy to use and intuitive. There is a help
  64.        line on line 25 and an optional title on line 1. The cursor controls
  65.        move around the file and the Esc key exits.
  66.  
  67.            Creating a text COM files is easy. Enter at the dos prompt:
  68.  
  69.        TXT2COM textfile comfile heading
  70.  
  71.            Textfile is the name of the ascii textfile to be converted.
  72.        Filenames can include disk and paths. Comfile is the name of the COM
  73.        file to be created. If you leave off the .COM, the program will add
  74.        one. Heading is anything you want to appear at the top line of the
  75.        display and can be any character (except dos pipe and redirect
  76.        characters) and any number of words. Headings are automatically
  77.        centered.
  78.            I created this file by entering:
  79.  
  80.             TXT2COM TXT2COM.DOC README.COM TXT2COM DOCUMENTATION
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95. ~#3
  96.        LIMITS:
  97.  
  98.             As a practical limit, text files should be no larger
  99.        than 50k. TXT2COM will convert files up to 55K, but there
  100.        are some factors to consider. Each line in the text file
  101.        expands the COM file by 2 bytes. The maximum size of a com
  102.        file is 64K. The driver takes up 2K. 64K - 2K - 55K leaves
  103.        7K for line numbers which is 3500 lines. If the 55k
  104.        text file averages 10 bytes per line then it has 5500 lines
  105.        and will not convert. If it has 20 bytes per line then
  106.        it contains 2,750 lines and will convert. The best way to
  107.        tell is to convert the file, display it and press the End
  108.        key. If you see garbage, then the file is too big.
  109.  
  110.             The memory resident version, TXT2RES.COM uses about
  111.        7.5K for its driver, most is screen buffer and stack and
  112.        the rest is code additions. This also limits the size of
  113.        the text file.
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120. ~#4
  121.                    ~40 Writing Out the Original File ~07
  122.  
  123.             You can write out the original text file to a file or to the
  124.        printer by choosing option "T". (Just press the T key while the COM
  125.        file is displaying the file.) The program will ask for a file name.
  126.        Simply enter the name of the file at the prompt. If you want to go to
  127.        a printer enter LPT1 or LPT2 (leave off the colon at the end).
  128.  
  129.             In resident files you cannot write out the original
  130.        documentation.
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145. ~#5
  146.  
  147.                              Changing Screen Colors
  148.  
  149.             You can control screen attributes through the use of the tilde
  150.        character (~). Normally the tilde is all but ignored. Tildes will
  151.        display as tildes except when a tilde is followed by two hex digits
  152.        or another tilde. Two tildes together mean force the display of a
  153.        single tilde, no matter what follows the second tilde. When a tilde
  154.        is followed by two hex digits the decimal number is converted to an
  155.        attribute and will change the screen colors from that point on. The
  156.        default color is 07 which is white on black. The attribute digits
  157.        will change this.
  158.             If you want to start out with an attribute other than the
  159.        default 07 just make sure that the first 3 characters of the text
  160.        file are a tilde sequence.
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173. ~#6
  174.                           Using Function Keys
  175.  
  176.            You may include a Tilde string which is used as a marker in
  177.       the text file. When a function key is pressed the program will search
  178.       forward until it finds the corresponding Tilde string.
  179.            The marker string is the combination of the Tilde character
  180.       followed by a pound sign (#) and then the number of the function
  181.       key from 1 to 0. (0 being the character used for function key 10).
  182.            More than one marker can be included in the text for the same
  183.       function key. If there is more than one function key, subsequent
  184.       pressing of the function key finds the next marker. The search
  185.       starts over again at the top when the bottom of the file is reached.
  186.            The tilde screens for each of the function keys are:
  187.  
  188.                    F1 = ~~#1         F6 = ~~#6
  189.                    F2 = ~~#2         F7 = ~~#7
  190.                    F3 = ~~#3         F8 = ~~#8
  191.                    F4 = ~~#4         F9 = ~~#9
  192.                    F5 = ~~#5         F10= ~~#0
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200. ~#7
  201.                 These are examples of screen attributes:
  202.  
  203.         Sequence      Display          Sequence      Display
  204.  
  205.             ~~00     ~00Screen Display~07      ~~10    ~10Screen Display~07
  206.             ~~01     ~01Screen Display~07      ~~11    ~11Screen Display~07
  207.             ~~02     ~02Screen Display~07      ~~12    ~12Screen Display~07
  208.             ~~03     ~03Screen Display~07      ~~13    ~13Screen Display~07
  209.             ~~04     ~04Screen Display~07      ~~14    ~14Screen Display~07
  210.             ~~05     ~05Screen Display~07      ~~15    ~15Screen Display~07
  211.             ~~06     ~06Screen Display~07      ~~16    ~16Screen Display~07
  212.             ~~07     ~07Screen Display~07      ~~17    ~17Screen Display~07
  213.             ~~08     ~08Screen Display~07      ~~18    ~18Screen Display~07
  214.             ~~09     ~09Screen Display~07      ~~19    ~19Screen Display~07
  215.             ~~0A     ~0AScreen Display~07      ~~1A    ~1AScreen Display~07
  216.             ~~0B     ~0BScreen Display~07      ~~1B    ~1BScreen Display~07
  217.             ~~0C     ~0CScreen Display~07      ~~1C    ~1CScreen Display~07
  218.             ~~0D     ~0DScreen Display~07      ~~1D    ~1DScreen Display~07
  219.             ~~0E     ~0EScreen Display~07      ~~1E    ~1EScreen Display~07
  220.             ~~0F     ~0FScreen Display~07      ~~1F    ~1FScreen Display~07
  221.  
  222.             ~~20     ~20Screen Display~07      ~~30    ~30Screen Display~07
  223.             ~~21     ~21Screen Display~07      ~~31    ~31Screen Display~07
  224.             ~~22     ~22Screen Display~07      ~~32    ~32Screen Display~07
  225.             ~~23     ~23Screen Display~07      ~~33    ~33Screen Display~07
  226.             ~~24     ~24Screen Display~07      ~~34    ~34Screen Display~07
  227.             ~~25     ~25Screen Display~07      ~~35    ~35Screen Display~07
  228.             ~~26     ~26Screen Display~07      ~~36    ~36Screen Display~07
  229.             ~~27     ~27Screen Display~07      ~~37    ~37Screen Display~07
  230.             ~~28     ~28Screen Display~07      ~~38    ~38Screen Display~07
  231.             ~~29     ~29Screen Display~07      ~~39    ~39Screen Display~07
  232.             ~~2A     ~2AScreen Display~07      ~~3A    ~3AScreen Display~07
  233.             ~~2B     ~2BScreen Display~07      ~~3B    ~3BScreen Display~07
  234.             ~~2C     ~2CScreen Display~07      ~~3C    ~3CScreen Display~07
  235.             ~~2D     ~2DScreen Display~07      ~~3D    ~3DScreen Display~07
  236.             ~~2E     ~2EScreen Display~07      ~~3E    ~3EScreen Display~07
  237.             ~~2F     ~2FScreen Display~07      ~~3F    ~3FScreen Display~07
  238.  
  239.             ~~40     ~40Screen Display~07      ~~50    ~50Screen Display~07
  240.             ~~41     ~41Screen Display~07      ~~51    ~51Screen Display~07
  241.             ~~42     ~42Screen Display~07      ~~52    ~52Screen Display~07
  242.             ~~43     ~43Screen Display~07      ~~53    ~53Screen Display~07
  243.             ~~44     ~44Screen Display~07      ~~54    ~54Screen Display~07
  244.             ~~45     ~45Screen Display~07      ~~55    ~55Screen Display~07
  245.             ~~46     ~46Screen Display~07      ~~56    ~56Screen Display~07
  246.             ~~47     ~47Screen Display~07      ~~57    ~57Screen Display~07
  247.             ~~48     ~48Screen Display~07      ~~58    ~58Screen Display~07
  248.             ~~49     ~49Screen Display~07      ~~59    ~59Screen Display~07
  249.             ~~4A     ~4AScreen Display~07      ~~5A    ~5AScreen Display~07
  250.             ~~4B     ~4BScreen Display~07      ~~5B    ~5BScreen Display~07
  251.             ~~4C     ~4CScreen Display~07      ~~5C    ~5CScreen Display~07
  252.             ~~4D     ~4DScreen Display~07      ~~5D    ~5DScreen Display~07
  253.             ~~4E     ~4EScreen Display~07      ~~5E    ~5EScreen Display~07
  254.             ~~4F     ~4FScreen Display~07      ~~5F    ~5FScreen Display~07
  255.  
  256.             ~~60     ~60Screen Display~07      ~~70    ~70Screen Display~07
  257.             ~~61     ~61Screen Display~07      ~~71    ~71Screen Display~07
  258.             ~~62     ~62Screen Display~07      ~~72    ~72Screen Display~07
  259.             ~~63     ~63Screen Display~07      ~~73    ~73Screen Display~07
  260.             ~~64     ~64Screen Display~07      ~~74    ~74Screen Display~07
  261.             ~~65     ~65Screen Display~07      ~~75    ~75Screen Display~07
  262.             ~~66     ~66Screen Display~07      ~~76    ~76Screen Display~07
  263.             ~~67     ~67Screen Display~07      ~~77    ~77Screen Display~07
  264.             ~~68     ~68Screen Display~07      ~~78    ~78Screen Display~07
  265.             ~~69     ~69Screen Display~07      ~~79    ~79Screen Display~07
  266.             ~~6A     ~6AScreen Display~07      ~~7A    ~7AScreen Display~07
  267.             ~~6B     ~6BScreen Display~07      ~~7B    ~7BScreen Display~07
  268.             ~~6C     ~6CScreen Display~07      ~~7C    ~7CScreen Display~07
  269.             ~~6D     ~6DScreen Display~07      ~~7D    ~7DScreen Display~07
  270.             ~~6E     ~6EScreen Display~07      ~~7E    ~7EScreen Display~07
  271.             ~~6F     ~6FScreen Display~07      ~~7F    ~7FScreen Display~07
  272.  
  273.             ~~80     ~80Screen Display~07      ~~90    ~90Screen Display~07
  274.             ~~81     ~81Screen Display~07      ~~91    ~91Screen Display~07
  275.             ~~82     ~82Screen Display~07      ~~92    ~92Screen Display~07
  276.             ~~83     ~83Screen Display~07      ~~93    ~93Screen Display~07
  277.             ~~84     ~84Screen Display~07      ~~94    ~94Screen Display~07
  278.             ~~85     ~85Screen Display~07      ~~95    ~95Screen Display~07
  279.             ~~86     ~86Screen Display~07      ~~96    ~96Screen Display~07
  280.             ~~87     ~87Screen Display~07      ~~97    ~97Screen Display~07
  281.             ~~88     ~88Screen Display~07      ~~98    ~98Screen Display~07
  282.             ~~89     ~89Screen Display~07      ~~99    ~99Screen Display~07
  283.             ~~8A     ~8AScreen Display~07      ~~9A    ~9AScreen Display~07
  284.             ~~8B     ~8BScreen Display~07      ~~9B    ~9BScreen Display~07
  285.             ~~8C     ~8CScreen Display~07      ~~9C    ~9CScreen Display~07
  286.             ~~8D     ~8DScreen Display~07      ~~9D    ~9DScreen Display~07
  287.             ~~8E     ~8EScreen Display~07      ~~9E    ~9EScreen Display~07
  288.             ~~8F     ~8FScreen Display~07      ~~9F    ~9FScreen Display~07
  289.  
  290.             ~~A0     ~A0Screen Display~07      ~~B0    ~B0Screen Display~07
  291.             ~~A1     ~A1Screen Display~07      ~~B1    ~B1Screen Display~07
  292.             ~~A2     ~A2Screen Display~07      ~~B2    ~B2Screen Display~07
  293.             ~~A3     ~A3Screen Display~07      ~~B3    ~B3Screen Display~07
  294.             ~~A4     ~A4Screen Display~07      ~~B4    ~B4Screen Display~07
  295.             ~~A5     ~A5Screen Display~07      ~~B5    ~B5Screen Display~07
  296.             ~~A6     ~A6Screen Display~07      ~~B6    ~B6Screen Display~07
  297.             ~~A7     ~A7Screen Display~07      ~~B7    ~B7Screen Display~07
  298.             ~~A8     ~A8Screen Display~07      ~~B8    ~B8Screen Display~07
  299.             ~~A9     ~A9Screen Display~07      ~~B9    ~B9Screen Display~07
  300.             ~~AA     ~AAScreen Display~07      ~~BA    ~BAScreen Display~07
  301.             ~~AB     ~ABScreen Display~07      ~~BB    ~BBScreen Display~07
  302.             ~~AC     ~ACScreen Display~07      ~~BC    ~BCScreen Display~07
  303.             ~~AD     ~ADScreen Display~07      ~~BD    ~BDScreen Display~07
  304.             ~~AE     ~AEScreen Display~07      ~~BE    ~BEScreen Display~07
  305.             ~~AF     ~AFScreen Display~07      ~~BF    ~BFScreen Display~07
  306.  
  307.             ~~C0     ~C0Screen Display~07      ~~D0    ~D0Screen Display~07
  308.             ~~C1     ~C1Screen Display~07      ~~D1    ~D1Screen Display~07
  309.             ~~C2     ~C2Screen Display~07      ~~D2    ~D2Screen Display~07
  310.             ~~C3     ~C3Screen Display~07      ~~D3    ~D3Screen Display~07
  311.             ~~C4     ~C4Screen Display~07      ~~D4    ~D4Screen Display~07
  312.             ~~C5     ~C5Screen Display~07      ~~D5    ~D5Screen Display~07
  313.             ~~C6     ~C6Screen Display~07      ~~D6    ~D6Screen Display~07
  314.             ~~C7     ~C7Screen Display~07      ~~D7    ~D7Screen Display~07
  315.             ~~C8     ~C8Screen Display~07      ~~D8    ~D8Screen Display~07
  316.             ~~C9     ~C9Screen Display~07      ~~D9    ~D9Screen Display~07
  317.             ~~CA     ~CAScreen Display~07      ~~DA    ~DAScreen Display~07
  318.             ~~CB     ~CBScreen Display~07      ~~DB    ~DBScreen Display~07
  319.             ~~CC     ~CCScreen Display~07      ~~DC    ~DCScreen Display~07
  320.             ~~CD     ~CDScreen Display~07      ~~DD    ~DDScreen Display~07
  321.             ~~CE     ~CEScreen Display~07      ~~DE    ~DEScreen Display~07
  322.             ~~CF     ~CFScreen Display~07      ~~DF    ~DFScreen Display~07
  323.  
  324.             ~~E0     ~E0Screen Display~07      ~~F0    ~F0Screen Display~07
  325.             ~~E1     ~E1Screen Display~07      ~~F1    ~F1Screen Display~07
  326.             ~~E2     ~E2Screen Display~07      ~~F2    ~F2Screen Display~07
  327.             ~~E3     ~E3Screen Display~07      ~~F3    ~F3Screen Display~07
  328.             ~~E4     ~E4Screen Display~07      ~~F4    ~F4Screen Display~07
  329.             ~~E5     ~E5Screen Display~07      ~~F5    ~F5Screen Display~07
  330.             ~~E6     ~E6Screen Display~07      ~~F6    ~F6Screen Display~07
  331.             ~~E7     ~E7Screen Display~07      ~~F7    ~F7Screen Display~07
  332.             ~~E8     ~E8Screen Display~07      ~~F8    ~F8Screen Display~07
  333.             ~~E9     ~E9Screen Display~07      ~~F9    ~F9Screen Display~07
  334.             ~~EA     ~EAScreen Display~07      ~~FA    ~FAScreen Display~07
  335.             ~~EB     ~EBScreen Display~07      ~~FB    ~FBScreen Display~07
  336.             ~~EC     ~ECScreen Display~07      ~~FC    ~FCScreen Display~07
  337.             ~~ED     ~EDScreen Display~07      ~~FD    ~FDScreen Display~07
  338.             ~~EE     ~EEScreen Display~07      ~~FE    ~FEScreen Display~07
  339.             ~~EF     ~EFScreen Display~07      ~~FF    ~FFScreen Display~07
  340.  
  341. ~#8                  Using TXT2RES.COM
  342.  
  343.             TXT2RES works the same as TXT2COM except that it creates
  344.        a COM file which can be included in an autoexec.bat to
  345.        make the text file resident. The file can be brought forward
  346.        at any time by pressing a HOT KEY combination. The default
  347.        hot key combination is:
  348.                      Alt-Left Shift-D
  349.              TXT2RES is good for creating resident tutorials and
  350.        references. Combined with the function key ability this can
  351.        create powerful interactive screens which can augment any
  352.        application.
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365. ~#9                   Changing the HOT KEY
  366.  
  367.            The default Hot Key combination is Alt-Left Shift-D.
  368.        This is fine for some uses, but when more than one application
  369.        uses this hot key combination or it conflicts in some way with
  370.        an application then you must run HOTFIX on the COM file that
  371.        you have produced. Do not run HOTFIX on TXT2RES.
  372.             HOTFIX works by changing the letter in the hot key
  373.        combination. It changes only the letter. The Alt-Left Shift
  374.        part remains the same. The form of the HOTFIX command is:
  375.  
  376.                HOTFIX filename n
  377.  
  378.        where filename is the COM file you want to fix and n is the
  379.        key letter that you want to change the hot key to. To change
  380.        the hot key combination of a resident file called apphelp.com
  381.        to Alt-Left Shift-H enter:
  382.  
  383.               HOTFIX apphelp.com h
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394. ~#0
  395.             This is a free product to all users with the exception of those
  396.        who wish to include the COM file produced with this product in a
  397.        commercial package (not freeware, shareware or user supported). When
  398.        the output of TXT2COM is included in a Commercial product I demand a
  399.        royalty based on product price and number of sales. For more
  400.        information write to: Keith P. Graham
  401.                              238 Germonds Road
  402.                              W. Nyack, NY 10994
  403.                              (914) 623-4161
  404.  
  405.             If you have any suggestions or comments you can direct them
  406.             to Keith Graham at PC-Rockland BBS (914) 353-2176.
  407.  
  408.  
  409.  
  410.